Skip to content

optimize: pre check dataChangeCreatedBy in updateItem#5316

Merged
nobodyiam merged 1 commit intoapolloconfig:masterfrom
k8scat:optimize-update-item
Jan 18, 2025
Merged

optimize: pre check dataChangeCreatedBy in updateItem#5316
nobodyiam merged 1 commit intoapolloconfig:masterfrom
k8scat:optimize-update-item

Conversation

@k8scat
Copy link
Contributor

@k8scat k8scat commented Jan 18, 2025 •
edited by coderabbitai bot
Loading

What's the purpose of this PR

在更新配置时，如果设置了createIfNotExists，提前校验dataChangeCreatedBy，返回更友好的错误提示

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced validation for item updates to ensure the dataChangeCreatedBy field is not empty when creating items conditionally.
    • Added a check to prevent updates without a specified creator.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jan 18, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 18, 2025 •
edited
Loading

Walkthrough

The changes focus on enhancing the validation logic in the updateItem method of the ItemController class within the Apollo Portal. A new validation check has been introduced to ensure that when creating a new item with the createIfNotExists parameter set to true, the dataChangeCreatedBy field must be non-empty. This modification improves error handling by explicitly requiring metadata when conditionally creating items.

Changes

File Change Summary
apollo-portal/.../ItemController.java Added validation to check dataChangeCreatedBy field when createIfNotExists is true, throwing a BadRequestException if the field is empty

Poem

🐰 In Apollo's portal, a rabbit's delight,
Validation springs forth, data shining bright!
No empty creators shall slip through the gate,
With metadata pure, we'll validate
Our configuration's pristine state! 🛡️

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1cbd987 and 816f0e0.

📒 Files selected for processing (1)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented Jan 18, 2025 •
edited
Loading

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@k8scat
Copy link
Contributor Author

k8scat commented Jan 18, 2025

I have read the CLA Document and I hereby sign the CLA

@nobodyiam nobodyiam force-pushed the optimize-update-item branch from 1cbd987 to 816f0e0 Compare January 18, 2025 11:29
nobodyiam
nobodyiam approved these changes Jan 18, 2025
View reviewed changes
Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 18, 2025
@nobodyiam nobodyiam merged commit 8acf075 into apolloconfig:master Jan 18, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jan 18, 2025
@nobodyiam nobodyiam added this to the 2.4.0 milestone Jan 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@nobodyiam nobodyiam nobodyiam approved these changes

Assignees

No one assigned

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

2.4.0

Development

Successfully merging this pull request may close these issues.

2 participants

@k8scat @nobodyiam